Skip to content

docs: add useContent headings guide#8073

Merged
gioboa merged 20 commits intoQwikDev:mainfrom
iitzIrFan:docs/usecontent-headings-guide
Jan 2, 2026
Merged

docs: add useContent headings guide#8073
gioboa merged 20 commits intoQwikDev:mainfrom
iitzIrFan:docs/usecontent-headings-guide

Conversation

@iitzIrFan
Copy link
Contributor

@iitzIrFan iitzIrFan commented Oct 19, 2025 •
edited by gioboa
Loading

What is it?

Fixed: #6678

  • Feature / enhancement
  • Docs / tests / types / typos

Description

  1. API Reference Update:
    A new section was added to the API reference file (index.mdx) to explain how useContent can retrieve headings from .mdx files. This included an example and practical use cases.

  2. New Practical Guide:
    A new file, use-content-headings.mdx, was created in the main documentation section. This file provides a user-friendly guide on using useContent to retrieve page headings, complete with an example, notes, and use cases.

Checklist

  • My code follows the developer guidelines of this project
  • I performed a self-review of my own code
  • I added a changeset with pnpm change
  • I made corresponding changes to the Qwik docs
  • I added new tests to cover the fix / functionality

@iitzIrFan iitzIrFan requested a review from a team as a code owner October 19, 2025 10:37
@changeset-bot
Copy link

changeset-bot bot commented Oct 19, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: dc87740

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@iitzIrFan iitzIrFan mentioned this pull request Oct 19, 2025
Closed
@github-actions
Copy link
Contributor

github-actions bot commented Oct 19, 2025 •
edited
Loading

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
qwik-docs ✅ Ready (View Log) Visit Preview 1bf3e9f

@AdrianRomanski
Copy link
Contributor

AdrianRomanski commented Oct 19, 2025

Looks like duplicate #7303

gioboa
gioboa requested changes Oct 20, 2025
View reviewed changes
Copy link
Member

@gioboa gioboa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to change the position of this file.
.../docs/use-content-headings.mdx
all the other pages are inside a specific folder.

@gioboa gioboa requested a review from maiieul October 20, 2025 08:10
@gioboa gioboa added the docs Improvements or additions to documentation label Oct 20, 2025
@gioboa gioboa changed the title Docs/usecontent headings guide docs: add useContent headings guide Oct 20, 2025
@iitzIrFan
Copy link
Contributor Author

iitzIrFan commented Oct 20, 2025

@gioboa Thanks for your review and yes had updates the position of the file.

@iitzIrFan iitzIrFan requested a review from gioboa October 20, 2025 11:51
@maiieul
Copy link
Member

maiieul commented Oct 23, 2025

Hey @iitzIrFan thanks for the PR. Giorgio and I think it would make more sense to have it in /docs/guides/mdx/. Can you do that change please?

@iitzIrFan
Copy link
Contributor Author

iitzIrFan commented Oct 23, 2025 •
edited
Loading

Sure @maiieul, updated the pr!

@maiieul
Copy link
Member

maiieul commented Oct 24, 2025

Thanks @irfanullahjan but I meant we already have a route https://qwik.dev/docs/guides/mdx/. Please move your changes here and remove the changes from /api.

@maiieul
Copy link
Member

maiieul commented Oct 24, 2025

The changes should be in the index.mdx

@iitzIrFan
Copy link
Contributor Author

iitzIrFan commented Oct 27, 2025

@maiieul PR updated! :)

@maiieul
Copy link
Member

maiieul commented Oct 29, 2025

@iitzIrFan thanks, but you need to put all your documentation changes in /docs/guides/mdx/. Have a look here https://github.com/QwikDev/qwik/pull/8073/files, you still have two other committed files and your docs changes aren't in /docs/guides/mdx/.

@pkg-pr-new
Copy link

pkg-pr-new bot commented Dec 30, 2025 •
edited
Loading

Open in StackBlitz

npm i https://pkg.pr.new/@builder.io/qwik@8073

npm i https://pkg.pr.new/@builder.io/qwik-city@8073

npm i https://pkg.pr.new/eslint-plugin-qwik@8073

npm i https://pkg.pr.new/create-qwik@8073

commit: dc87740

gioboa
gioboa approved these changes Jan 2, 2026
View reviewed changes
Copy link
Member

@gioboa gioboa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I moved your content in the right place.
Thanks for your help @iitzIrFan 🚀

@gioboa gioboa enabled auto-merge (squash) January 2, 2026 13:09
@gioboa gioboa merged commit e8d8767 into QwikDev:main Jan 2, 2026
15 checks passed
@iitzIrFan
Copy link
Contributor Author

iitzIrFan commented Jan 2, 2026

Thanks for help there @gioboa 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gioboa gioboa gioboa approved these changes

@maiieul maiieul Awaiting requested review from maiieul

Assignees

No one assigned

Labels

docs Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[📖] Document more thoroughly the use case for useContent with current page's headings

4 participants

@iitzIrFan @AdrianRomanski @maiieul @gioboa